# Copyright (c) 2025 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations

from paddle.base import core

__all__ = ["initial_seed"]


def initial_seed() -> int:
    """
    Returns the initial seed for generating random numbers as a Python `int`.

    Returns:
        int: The 64-bit initial seed of the default generator on CPU place only.

    Examples:
        .. code-block:: python

            >>> import paddle
            >>> s = paddle.random.initial_seed()
    """
    return core.default_cpu_generator().initial_seed()
